STREETBALL REVIVAL - START HERE
===============================

A PC rebuild of a 2003 PlayStation 2 three-on-three streetball game, with
online play. This is a PUBLIC BETA: most of the game plays like the
original, but expect some bugs and missing pieces.

The download holds no game data. The game reads everything (players,
courts, music, movies) from a disc image of YOUR OWN copy of the original.


WHAT YOU NEED
-------------
- This folder, unzipped (don't run the game from inside the zip). Or, on
  Windows, the one-file download StreetballRevival-...-windows.exe.
- A disc image (.iso) of the original game, USA PlayStation 2 release,
  serial SLUS-20651. Other regions won't work.
  To make one: put your disc in a PC DVD drive and save it as an .iso with
  any disc-imaging program. Keep the .iso anywhere on your PC.
- A graphics card that supports DirectX 12 or Vulkan (most made since
  about 2015).
- Optional: a controller. PlayStation, Xbox and most other pads work; plug
  one in any time. The keyboard works too.


FIRST RUN
---------
1. Open StreetballRevival.exe, the one program at the top of this folder
   (on Linux: ./StreetballRevival). The game's other programs are in bin;
   you never need to open them.
2. Windows may show "Windows protected your PC", because this free
   project's files aren't signed. Click "More info", then "Run anyway".
3. Press Browse and pick your .iso (or drag the .iso onto the window).
   The launcher checks that it is the right release and remembers it.
4. Press Play.

The very first launch can show only sky for a few seconds while your PC
prepares its graphics. Later launches start faster.


CONTROLS
--------
Action                          PlayStation    Xbox           Keyboard
Move                            Left stick     Left stick     WASD / arrows
Shoot (near the rim: dunk)      Circle         B              J / Space
Pass (on defence: switch)       Cross          A              K
Trick move / steal              Square         X              L
Jump: block, rebound            Triangle       Y              I
Turbo (hold 1 to 4)             L1 R1 L2 R2    LB RB LT RT    Q Shift R E
Pocket / cancel a gamebreaker   Select         View           P
Pause                           Start          Menu           Esc / P

In menus: arrows or WASD to move, Enter (or Space / J) to pick,
Esc (or Backspace) to go back.

Tricks: hold turbo buttons while pressing the trick button. The more turbo
buttons you hold, the fancier the move. Tricks fill your gamebreaker meter;
when it is full, shoot for a gamebreaker.


SETTINGS
--------
Main Menu > Options > Adjust Screen opens PC Settings:
full screen or window, the wide picture, controller vibration, Online,
Watch A Game (the computer plays both sides) and your created teams.


PLAYING ONLINE (work in progress)
---------------------------------
On the Main Menu press Select (P on the keyboard) for Online.
- One person picks Host 1 vs 1 or Host 3 vs 3 and sends friends the code
  shown in the lobby (like 7QK3-M2X).
- Friends on the same network see "Join <name>"; anyone else picks
  Join With Code.
- Everyone needs their own disc image of the same USA release.
- If Windows asks to let street-game.exe use the network, tick Private and
  Public and press Allow.
"HOW TO PLAY ONLINE.md" in the docs folder covers routers, port 7375 and the
VPN fallback.


YOUR SAVE
---------
Your progress and the launcher's settings live in
Documents\Streetball Revival (street_save.dat and launcher.json).
Back that folder up to keep your progress. To point the launcher at a
different .iso, press Change disc.


TROUBLESHOOTING
---------------
- "This disc isn't the USA PlayStation 2 release" or "That file isn't a
  disc image": the image must be the USA release, SLUS-20651, saved as a
  whole-disc .iso (not a folder of files, not a compressed .chd or .cso).
- "The game's files weren't found": keep the whole folder together;
  StreetballRevival.exe starts the game from its bin folder.
- Controller not working: unplug it, plug it back in and press a button
  on it while a menu is showing.
- Linux: if the files won't start, make them runnable with
  chmod +x StreetballRevival bin/*
  The game needs ALSA, udev, Wayland or X11 and a Vulkan driver, which
  most desktops already have.


FEEDBACK
--------
Report bugs, or anything that plays differently from the original, on the
Discord (https://discord.com/invite/htu5pdxPQz) or as an issue at
https://github.com/luckvj/streetball-revival/issues
Say what you did, what you expected and what happened. Please don't
attach disc images or game files.


MADE WITH THE HELP OF AI
------------------------
Much of this rebuild was written with the help of a large language model
(LLM), so some features may be missing or behave differently from the
original.


LEGAL
-----
An unofficial fan project, not affiliated with or endorsed by any rights
holder of the original game. Its own code is under the MIT licence
(docs/LICENSE). See docs/LEGAL.md for the full notice.
